Broadband - Appointment Management API - TMF646

API Request Payload

HTTP query parameter	Example Field Value	Description
id	APP22	The PXC Id of an appointment
fields	N/A	Not used in this API. If this parameter is passed in with any values will be ignored.

HTTP Header Name	Example Field Value	Description
Correlation-ID	c97de875-44fa-4b49-9f3b-015d15a14efe	A GUID to relate requests belonging to the same transaction

HTTP URI	Example Field Value	Description
/appointment/{id}	APP1234	The id is the PXC appointmentId. It is the same that is returned to partners as part of the POST /appointment response.

API Response Payload

HTTP Header Name	Example Field Value	Description
Correlation-ID	c97de875-44fa-4b49-9f3b-015d15a14efe	A GUID to relate requests belonging to the same transaction

Payload Field Name	Example Field Value	Description
id	APP1234	Unique identifier of the appointment. A PXC reference.
href	/appointment/{id}	The URI of the resource.
supplierAppointmentId	1234	Extension to the API. Unique supplier reference appointment. A value generated when Openreach creates an Aline appointment.
openreachAppointmentId	1234	Extension to the API. Unique Openreach reference for scheduling an appointment. A Fiber Cable reference.
category	Repair Provision Modify	It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification.
appointmentType	Standard Flexible	Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers.
externalId	432113	A Partner’s reference Id. Part of Standard TMF646 spec.
description	Fix an internet connection problem for a customer	Short free text describing the appointment. Part of Standard TMF646 spec.
creationDate	2025-02-01T14:48:45.071Z	Timestamp of the appointment creation date.
lastUpdate	2025-02-01T14:48:45.071Z	Timestamp of the last time Appointment was updated.
status	initialised scheduled cancelled completed	Current status of the appointment. Matches the GET /appointment resource.
requestedExecutionDate	2025-02-01T14:48:45.071Z	Extension to the API. Timestamp until which appointment transaction will be scheduled. It means we are asking Openreach to schedule the appointment before this date.
validFor		Time interval appointment is valid for.
validFor\startDateTime	2025-02-15T08:00:00.000Z	Timestamp of the start time of the appointment. (UTC timestamp)
validFor\endDateTime	2025-02-18T08:00:00.000Z	Timestamp of the end time of the appointment.
relatedEntity	See relatedEntity table	array for AccessCASR contains a AccessCASR and the BillingAccount elements id = {{AccessCASR}} role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = {{ProductId}} role = relatedProduct @referredType = Product for CLI contains the CLI and the BillingAccountId elements id = {{CLI}} role = impactedVoiceService @referredType = Service
note	See Note table	array
@type	PXCAppointment
@baseType	Appointment

Related Entity Table

Field Name	Example Field Value	Description
id	AP12345678 FTTP12345678 SOGEA12345678 01234567891 INC123456789101 00000069 AO12345678	Mandatory - Unique Id - eg: ProductId, AccessCASR, CLI, TicketId, BillingAccountId or OrderId
role	relatedProduct relatedService relatedTicket relatedAccount relatedOrder impactedVoiceService impactedDataService	Mandatory - Role played by the client. relatedProduct when Id is ProductId relatedService when Id is AccessCASR relatedTicket when Id is TicketId relatedAccount when Id is BillingAccountId relatedOrder when Id is OrderId impactedVoiceService when Id is CLI impactedDataService when Id is CLI
@referredType	Product Service Ticket BillingAccount Order	Mandatory - The actual type of the target instance Product when Id is ProductId Service when ID is AccessCASR & CLI Ticket when Id is TicketId BillingAccount when Id is BillingAccountId Order when Id is OrderId.

Note that relatedEntity of @referredType=Ticket is expected in requests when an appointment is being reserved for an existing ticket